GitHub Actionsでのドキュメント自動化
GitHub Actionsを使ってドキュメントの保守作業を自動化する手法。
ユースケース
ナレッジベースの定期メンテナンス
Obsidian入門 vaultなどをGit管理している場合、定期実行で以下を自動化できる:
- リンク切れ検出
- 週次サマリー生成
- frontmatter補完
- 孤立ノートレポート
基本構成
name: Vault Analysis
on:
schedule:
- cron: '0 9 * * 0' # 毎週日曜9時
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: pip install anthropic
- run: python scripts/analyze_vault.py
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
- run: |
git add -A
git diff --staged --quiet || git commit -m "Auto: analysis"
git push
設計のポイント
1. APIキー管理
ANTHROPIC_API_KEYはRepository Secretsに保存。コードには含めない。
2. 差分コミット
git diff --staged --quiet || で変更がある場合のみコミット。空コミットを避ける。
3. スケジュール設定
cron構文で実行タイミングを指定。週次・日次など用途に応じて調整。
AI活用との組み合わせ
Claude APIを使った自動処理例:
- 新規追加ノートの要約
- タグの自動付与提案
- 関連ノートの抽出
注意点
- API使用量の監視(定期実行による予期せぬコスト増加)
- レート制限の考慮
- 自動コミットのレビュー体制